Skip to main content
POST
/
public
/
v1
/
offsite-ads
/
audiences
/
user-list
[BETA] Create offsite user list audience job.
curl --request POST \
  --url https://api.topsort.com/public/v1/offsite-ads/audiences/user-list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "This is a user list audience description."
}
'
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Query Parameters

​
vendor_id
string
required

The ID of the vendor to create the audience job for.

Example:

"vendor_123"

​
dsp
enum<string>
required

The DSP to create the audience job for.

Available options:
google_ads,
meta
Examples:

"google_ads"

"meta"

Body

application/json
​
name
string
required

The name of the user list audience.

Minimum string length: 1
Example:

"My user list audience"

​
description
string | null

The description of the user list audience.

Minimum string length: 1
Example:

"This is a user list audience description."

Response

Successful Response

​
jobId
string<uuid>
required

The unique identifier for the queued job.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
url
string
required

The presigned url to upload the audience csv file. Presigned url must be used with PUT method and include the header Content-Type: text/csv.

Example:

"https://offsite-ads-user-list-uploads.s3.us-east-2.amazonaws.com/123e4567-e89b-12d3-a456-426614174000.csv"